Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create install-mdbook.sh and lock to the current versions used in the CI #2626

Merged

Conversation

michael-kerscher
Copy link
Collaborator

@michael-kerscher michael-kerscher commented Feb 5, 2025

Move mdbook installation into a script and use exact versions from the CI.
Update README.md to instruct developers to use the same versions as the CI to sync both environments.
This is related to #2620 and it fixes #2588

@michael-kerscher
Copy link
Collaborator Author

Should I move the install script into some subfolder to have the root more clean? I cannot find a suitable existing folder for this. I could create a scripts/ folder but this would for now only contain this file

@djmitche
Copy link
Collaborator

djmitche commented Feb 5, 2025

Should I move the install script into some subfolder to have the root more clean? I cannot find a suitable existing folder for this. I could create a scripts/ folder but this would for now only contain this file

I don't think this is necessary!

Copy link
Collaborator

@djmitche djmitche left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@michael-kerscher michael-kerscher merged commit 715a23e into google:main Feb 5, 2025
35 checks passed
@michael-kerscher michael-kerscher deleted the sync-versions-ci-dev branch February 5, 2025 14:33
michael-kerscher added a commit to michael-kerscher/comprehensive-rust that referenced this pull request Feb 7, 2025
… CI (google#2626)

Move mdbook installation into a script and use exact versions from the
CI.
Update README.md to instruct developers to use the same versions as the
CI to sync both environments.
This is related to google#2620 and it fixes google#2588
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect behavior with mdbook serve compared to published version.
2 participants